<R"A N N O U N E M E N T!!","[cb]AssistPrefs|[c]Assist prefs is released.|[C]You can find it in Aminet(text/hyper).|[c]With it you can edit the tooltypes, the startup|[c]configuration and the properties of Assist with just|[c]one program.|[c2b]F R E E W A R E|[c]Written by Mark Papadakis">
This is a major update of Assist
<L"Introduction","Intro"> - What is it all about?
<L"Author","Author"> - Well...
<L"Legal stuff..","Legal"> - Something that you should know
<L"Distribution","Distribution"> - GIFTWARE!
<L"CyBERDYNE SySTEMS","CS"> - About this new development team
<L"Coding Assist","CodeInfo"> - To blitz programmers
<L"Greetings list","Greetings"> - Classic...
<L"Requirements","Requirements"> - What do you need to run Assist
<L"Convert","Convert"> - About the utility convert
<L"Advices..","Guide"> - It would be nice to check this out
<L"AREXX support","AREXX"> - AREXX support from ASSIST
<L" FAQs ","FAQs"> - Frequently Asked Questions
Copyright [C]1995, Mark 'Force' Papadakis
If you want to get hold of the last version, please <E"click me","ED Aux_Prg:Docs/Registration.Form">..
<U><B><I>CLI usage<UA>
Assist [filename.help [node]]
DISCLAIMER
All the icons, except the Assst and the installation icons, are not mine
(found in Aminet). I would like to thank their creators.
<I"Exit browser","Quit">
Last updated:21.11.95
>EndNode
>Node "Intro"
>Title "Assist - The interactive guide"
>Font "DGSansSerif.Font(13)"
<B>Assist<UB> is a hypertext based guide, like MultiView® or AmigaGuide®
BUT not excactly! To cut the long story short, just read the rest of this
'node' ;I will explain to you what a node is later...
<Dl>
<I><B>FEATURES<UB><UI>
* Run as commodity.
* Features an AppIcon for drag'n'drop.
* Uses an AppWindow for easier browsing.
* Uses AppMenus for even more control.
* Supports AREXX.
* Reads Assist and AmigaGuide® documents.
* Startup configuration; You can configure Assist depending on the
free memory you have.
* It is a fast, hypertext based, guiding system. It supports several
file types into its documents:ASCII files, AmigaDOS programs, Pictures
sounds and user programable requests.
* It supports any font, proportional or not.
* It is fully configurable.
* It can use the Workbench screen, the current screen or even a public one.
* It supports external modules.
* It is very popular here :-)
* It comes with several utilities.
* It is tottaly free!
* It is getting better every day!
* And more...
<DL>
<I><B>Improvents<ub><ui>
Improvements since last version (V1.6)
* Convert now handles correct the '@Master' and '@Database' commands.
* Improved tooltypes support.
* Better keyboard control.
* Convert now handles correct the font styles.
* Improved loading process
* Fixed bug which meant that once you had a title with more than
a certain total number of characters, Assist would display the
half title and the rest would be displayed as a line.
Thanks for reporting it!
* Fixed bug in Convert (Sometimes it would just stop processing!)
* Fixed hypertext handling bug.
* Assist now handle the TAB character.
* Improved docs.
<i>I think i covered every request/suggestion concerning Assist besides <ui>
<i>the 'bug' with the non 8p screen fonts. Dont worry though! <ui>
<i>Soon, i will fix that too! <ui>
<i>A guy mailed me and asked me to include inline images in the docs <ui>
<i>or something. If you are this guy, please <L"email me","Author"> becouse <ui>
<i>it seems a cool idea! <ui>
---Please, checkout the <L"improvements","NEW"> chapter for more.
<dL>
<B>How to use<UB>
Use the <L"menus","Menus"> or the <L"keaboard shortcuts","Keyboard">. In order to read the whole
thing, use the scroller, the arrows or the cursor keys.
If a phrase is highlighted, then by moving the mouse pointer on it, the
mouse pointer will turn to something else.
(If you have activated the appropriate menu option).
You can see what will happen if you press the left mouse button at the
bottom of the window, next to the Assist little icon.
(Again, if you have activated the appropriate menu option).
If you press the left mouse buton, the action will be carried out. Easy!
Just in case, take a look at this cute <S"picture","AUX_PRG:Docs/PIC1.IFF"> (hm..)
<DL>
<b>How to write a .help document?<ub>
Well, you have two choices. You could have three but i am too busy
at the time to complete my .help authoring tool..Anyway
The first one is to use an AmigaGuide® authoring tool, like the great
<r"Heddley","[c]Heddley is supposed to be the best AmigaGuide® authoring tool|[c]And i guess they are right!"> and then convert it to a .help file using <l"Convert","Convert">
or you can write it using a text editor(preferably without the wrap text
facility, or one that will allow you to deactivate it.) <R"CED Pro","My favourite editor!"> is great
for this task. Using the first way is easier but you loose some of the
extra features of <b>Assist<ub>, since <P"none","AUX_PRG:Docs/mad.8svx"> of the authoring tools for
AmigaGuide® documents support them, so far.. You would have to edit them
or use the second way in order to use those facilities(requesters, Amiga
DOS files etc). Your file must have a .help extension. As for the
supported commands so far, check the <V"appropriate file","Aux_Prg:Docs/Commands"> in the AUX_PRG:Docs
directory. Remember that <b>ALL<ub> .help files <b>MUST<ub> have a node called Main.
A node is a part of the document which forms another document. Just
like the AmigaGuide®. Note also that the host screen must have a
normal <R"10p bar","That means that the host screen must use a normal 8p font|[c]e.g topaz.font"> otherwise Assist wont even let you have a glance of it!
The host screen must be at least 500X200. If not, Assist wont run on that
screen.
If you want, i can offer custom screen support in version 1.8 but i
really think that this wont be so usefull; Its up to you!
<u>About public screens<uu>
Public screens opened with BlitzII ScreenTags command are not accepted!
I dont know why! The public screen is in the public screens list BUT
you cant lock it! (lockpubscreen() function). ACID!!...
I suggest you read my <l"advices","Guide"> before starting writting
your own .help files.
<DL>
<B>Are there any bugs?<uB>
Well, there are some but very minor ones. The first one is that the
scroller might couse you some trouble. You see, this is the last
type of gadget i wrote the code for(as i told you, i use my <i>MPInterface<ui>
routines) and i haven't test it that much..
Dont worry that much though..I said that it MIGHT couse you trouble!
I had no problems..
BlitzII is not that fast!(<P"RoadRunner!","AUX_PRG:Docs/RoadRunner.8svx">) :-( I hope V2.1 is faster!
Another thing; When you use Assist as the default tool for an icon, it
wont work!! BlitzII takes only the name in and it excludes the path!!!
Serious <P"bug","AUX_PRG:Docs/Bubbles.8svx">! Therefore the .help file must be in AUX_PRG: in order to
run by double clicking its icon!!! ACID:Do something! This happens
when you set Assist as the default tool for an icon, i repeat.
Note that i can do nothing for the two previous bugs 'couse BlitzII
take care of stuff. I would have to use direct calls to AmigaOS for
them. (i.e edit$(), which is supposed to do the same thing that
fgets() function of C does, is the reason that Assist WAS so slow while
loading (V1.0-1.4) ). As for the second bug, it is really very odd..
That was all! Not really bugs but hey, 'good bug is only the dead bug!'
(That was not mine, it is copyrighted by a philosopher whose name i cannot
remember now).
Another bug..When Assist is iconified, you can access the menu option
only by using their keyboard shortcuts. It doesn't make sense to me!
LATEST REPORT!
-------------
<b>DO NOT<ub> start Assist from <R"ZShell","[c]A shell utility with some|[c]cool features.|[c]Can be found in Aminet">!! Somehow, ZShell manage to couse
<b>SEVERE<ub> problems to Assist! Simply exit ZShell and use shell or run Assist
from WBench. I will try to workout what the .... is going on!
<DL>
<B>Future<UB>
Assist certainly has a future ahead..Some things that i will (might) add
are the following:
* Fix any possible bugs (please, read previous paragraph).
* More commands! (I need your <L"suggestions","Author"> on this one please).
* I am planning to support ALL commands of AmigaGuide® (well, almost..)
The big problem is that i dont have all the commands of AmigaGuide®!
If anyone has the AmigaGuide® developers pack, please uuencode-email
it to me. Frankly, i dont know what else to add!
* Improved AREXX support. (How can i set AREXX variables from within BlitzII?)
* An authoring tool for Assist documents!
I am working on it!
<b>THIS PROGRAM IS GIFTWARE! BUT, SINCE YOU WILL USE IT, I NEED <ub>
<b>YOUR SUGGESTIONS ON IT. I WANT A PROGRAM THAT WILL DO WHAT YOU<ub>
<b>WANT AND WILL FULFIL ALL YOUR NEEDS. THATS WHY JUST EMAIL ME!!<ub>
If you have any ideas, please mail <L"me","author">..BTW:I am looking
for some code about datatypes support from within BlitzII. Any help
is welcome!
If you want to know the next version of Assist you have some alternatives:
1. finger gsa50@elyros.cs.teiher.gr and you will see some cool stuff!
(Thats if i have updated my .project file ;-)
2. Email me (gsa50@cs.teiher.gr) and ask for the next version.
I will uuencode and sent it over to you.
3. Check http://tylissos.cs.teiher.gr (if my page is ready you will
be able to d/l any program of <L"CyBERDYNE SySTEMS","CS"> from there!)
<B><I>NEW! <UA>
The <B>WWW<UB> server of <B>TEI<UB> is finally ready! You can
access it with AMosaic, Netscape or any other HTML browser. The URL is
<u>http://tylissos.cs.teiher.gr<uu>
It is still under construction but soon it will have more pages and
i will also have my own page there...
You will be able to d/l the latest projects of <L"CyBERDYNE SySTEMS","CS"> from my page.
Do me a favour:Mail to gsa17@cs.teiher.gr (a friend of mine...) and tell
him what do you think about the server. We really want it to be a good
one!
<DL>
<b><i>Background<ua>
I was using AmigaGuide® documents for all my projects but it wasn't
that good for me. I mean AmigaGuide® is limited to WB3.0+ users as
far as the fonts and the datatypes are concerned. So, i decided to
write <P"my own hypterext guide","AUX_PRG:Docs/Yeah.8svx">. During the development i added some more
features. I hope you like it. I certainly decided to use it from
now on instead <P"AmigaGuide® documents","AUX_PRG:Docs/Booh.8svx">. Convert was created to help
me test Assist. But, during the Assist's development, i made
convert even more capable and now it can convert any .guide file to
a .help file vice versa.
<dl>
<B><I>Registration<UA>
This program(including all the acompanying files in the archive) is
GiftWare. That means that you can <L"distribute","DISTRIBUTION"> it free.
However, money or even gifts(programs that you have written, postcards or
even a (e)mail) are appreciated and would be very important to <L"me","Author">. I mean
that this would show that you find the program useful.
The source files for convert and MPInterface are at your disposal
if you decide to contribute! (Sorry but Assit code is just to..secret!)
Mark Papadakis 21.11.95
>EndNode
>Node "Author"
>Title "Programmer's profile"
Well, as you might know, this program was written by a certain
Mark Papdakis, me that is..I am a 19 years old student of engineering at the
<R"TEI","[c]WWW:http://tylissos.cs.teiher.gr"> at <R"Heraklio","[c]The biggest city of Crete"> <R"Crete","The biggest and the most beatiful|[c]island of Greece!">, <R"Greece","[c]The place with the best beaches|[c]the best women|[c]and the famouse history">. (STEF Engineering). Now i am using
BlitzII and C++. I was using AMOSPro a few years ago, but i dropped that
language 'couse, frankly, its a crap! I am a member of <L"CyBERDYNE SySTEMS","CS">
(actually, i am the applications programmer). I am programming since '87
when i bought my first computer, the classic Amiga500.
Besides that...hm..i love programming, music, brunettes
working out(in gym) etc etc
If you want to know more(and you are a girl more that 16 years old
and less that 30 years old, preferably, just email me..)
Note:No offence..right?
-------------
|\ /| To:
| \ / | Mark Papadakis
SnailMail | \ / | Fournofarago Monofatsiou
| \ / | Heraklio Crete, Greece
| \ / | P.O 70010
| \/ |
| |
--------------
Email 0011010011010 gsa50@cs.teiher.gr
________
/ | | \
| |
______
Phone / .... \ (+31)0893 41516
/ .... \
----------
IRC bla-bla-bla MarkForce (#amiga, #hellas)
Please, feel free to contact me..
<i>Sorry but i check my mail once or twice a week! This will be happening until
20 of February 1996. After this date i will be online the whole day!<ui>
(It is kind of complex to explain but..)
BTW:If you have an idea for a program (anything!) just email me! I
really dont know what else to do!! (Well, i have to update all those
programs but i like working on new projects).
If you are Greek and you have TopazGr.font, then <L"click me","Greek"> for more..
If you have any ideas, please mail <L"me","Author">
>EndNode
>Node "CodeInfo"
>Title "Coding the program"
This program was written using <R"BlitzII","[ciu]A superb programming language!|[c]If it was a bit faster..|[c]I am waiting for V2.1|[bc]Copyright ACID Software"> V1.9 and <R"CED Pro","[c]A great word processor|[cb]Copyright Elastic Reality, former ASDG">.
<R"Heddley","[cb]Copyright Edd Dumbill|AmigaGuide authoring tool"> was used too as <R"PersonalPaint","[c]A nice painting program|[cb]Copyright Cloanto Inc">. <R"ObjManip","The best objects manipulator!!"> V2.1 was used in great
doses for all the graphics manipulation.
It took me 4 days to code all the things that are in the archive(V1.0!).
Well, <R"MPInterface","[c]Routines for BlitzII for a brand new interface!"> which is partially used in Assist was programmed some time
ago.. Convert is about 1670 lines of BlitzII code while Assist is about
10200.
As i 've heard the new version of <b>BlitzII<ub>(2.1) is out! As soon i
will be able to purchase a copy of it, i will <B><I>*SERIOUSLY* <UA>update it!
<b>RIBlitzLibs<ub> are utilised (Check <L"improvements","NEW"> chapter please).
>EndNode
>Node "Greetings"
>Title "Hello goes to.."
There are a lot persons that i would like to say 'hello' to and i am
sorry for not mentioning some of them..
Nick - My friend from CyBERDYNE SySTEMS for his cooperation.
George - My twin brother, for not doing much actually..
GeorgeJR - For bugging me:-)
<R"Pantelos","He is about to become a military doctor now.."> - My favourite cousine! For a lot of things!
<R"Alex","Email :alpapad@csd.uch.gr OR alpapad@knossos.forthnet.gr"> - Pantelo's bro. Sysop of Knossos BBS and networks expert.
John - My buddy..
Jim - My buddy#2!
GeorgeK - My contact in Rumania..!
<R"Vana","Email :kaloger@csd.uch.gr"> - For her friendship.. :-)
Stella - Hi there!!!
<R"Mikko Makela","Email :mmmakela@cc.helsinki.fi"> - For the BlitzII mailing list
All those guys from <R"Blitz mailing list","Email :blitz-list@helsinki.fi"> who helped me to upload this!
<L"Load","MENU_Load"> <R"Main","Go to the node Main|As i said, every .help file NEEDS a node called Main"> <L"Properties","MENU_PROPERTIES"> <R"Report typos","If this is off then|syntax errors wont be reported."> <R"How to use","A requester, just like this, will|explain you the basics">
<R"Info","Misc information"> <R"Next","Go to the next node"> <R"Save","Save default prefs"> <R"Smooth Scroling","Enables/Disables smooth scrolling feature"> <R"About Assist,"The most common feature of all programs!">
<R"Quit","Dont tell me that you dont know what is that!!|Pressing ESCape you will couse the same result"> <R"Prev","Go to the previous node"> <R"Load","Load default prefs"> <L"GFX Colour","MENU_GFXCOLOUR">
<L"Iconify","Menu_Iconify"> <R"Back","Go to the 'parent' node.|If not parent is set(using the TOC command)|you will go to the Main node"> <R"Toggle pointer","If this is on the the mouse pointer will change to a..finger|when you move it on highlighted text(indicates actions)|indicating that something can happen if you press the left mouse button.">
<R"AREXX script","[c]Eexecute an AREXX script."> <R"Retrace","Go to the previous, not in document, in memory, node.|Try and you will understand!"> <R"Display actions","If this is on then you will be able to see what will|happen if you press the left mouse button.">
<L"Select","MENU_SELECT">
<R"Index","Takes you to the index of the document|(if there is such a node defined)">
<R"Help","Takes you to the help node of the document(if it is defined)">
I suggest you use their equivelant keyboard shortcuts. It saves time.
>endnode
>Node "Menu_Properties"
>Toc "Menus"
>Title "Menu Navigate/Properties"
There are several gadgets on this <S"window","AUX_PRG:Docs/PIC2.IFF">.
<b>Regular pen<ub> :The pen used for the text(not actions related text)
<b>Highlight pen<ub> :The pen used for the actions related text
<b>Background<ub> :Background color
<b>PicViewer<ub> :The name of the external pictures viewer. Therefore you
can use any picture as long as the external viewer support it.
Only external supported.
<b>SoundPlayer<ub> :The external sound player name. Like the previous gadget
if a player is good enough you wont have to care about the sound format.
Play16 is a great one. I wrote an internal player for this. It can handle
only 8SVX files though. Just select Internal to activate it.
<b>TextReader<ub> :Again, the external text viewer name. If this is a good
one (ANSI support etc) then even better!
<b>NOTE<UB> DO NOT select external modules that run as detached processes!
This wont be good! Dont worry though; Most of them dont!
<b>New Look...<ub> :If this is on, then you will have the new look scroller
instead of the old one!
<b>Default font<ub> :You can use ANY font in ANY size! Just select one!
Note that this font will be used when you load a file and when the current
node doesn't have a font assigned to it.
Next to each external module selection gadget, there is a string gadget.
You can enter some special arguments. For example, my sound player
(play, found in Aminet) can play any sound but displays a window while
playing. If you use 'play filename q' the window will not be displayed.
So, i enter q in the appropriate string gadget and everything is cool!
<dL>
<u>Some advices on this<uu>
I recommend you use modules that do not use much memory since memory
is VERY important. Also, if you have any special players/viewers then
use them! For example and ANSI text viewer is better that a simple
ASCII viewer, a player which can play any sound file is much better than
one that can play only 8SVX IFF files(Play16 is great!) and a pic viewer
which can display any picture format and also plays animations is
much better than a simple IFF viewer(ViewTek is recommended).
<dl>
<b>Confirm<ub> :Confirm all actions (Also Return or Confirm from menu)
<b>Cancel<ub> :Cancel all changes (Also ESCape or Cancel from menu)
>EndNode
>Node "Menu_Select"
>toc "Menus"
>title "Navigate/Select"
You can manually select a node to go to. Use the cursor keys, enter and
escape keys or use the gadgets to <S"select","AUX_PRG:Docs/PIC3.IFF"> one.
TopazGr font is used for this as the ListView gadget has some problems
working with just any font. I used TopazGr 'couse greek users will be
benefited from that. Sorry if i coused any problems!
>endnode
>node "Menu_Iconify"
>TOC "MENUS"
>Title "File/Iconify"
Close the main window, free the AppWindow and go in iconification mode.
The menuitem Iconify will be renamed to UnIconify (Select it to uniconify).
A small window will open(info window). There are three avaible options.
Time - Assist displays the current time.
Time&Date - Assist displays the current time and the current date
(date is displayed every five seconds).
Memory - Assist displays the free memory (Chip and Fast).
Default is Time. If you have used the tooltype <B>SHOWDATE<UB> then
Assist will use the mode Time&Date. If you have used the tooltype
<b>SHOWMEM<UB> Assist will use the mode Memory.
NOTE:Assist will automatically uniconify if you double click the
AppIcon or load a file or select a node.
If the Assist is paused(please, checkout <L"improvements","NEW">) then
nothing will be displayed but the current version of Assist.
>ENDNODE
>Node "MENU_GFXCOLOUR"
>Title "Gfx colour options"
>TOC "Menus"
Assist also support graphics. So far, only simple lines are supported
but in future versions more complex graphics commands will be suported.
There are three options for the rendering colour.
<B>Regular pen<ub> :Use the colour used for plain text (Default).
<b>Highlight pen<ub> :Use the colour used for highlighted text.
<b>Comlement<ub> :Use a complement colour of the background.
>EndNode
>Node "menu_load"
>toc "MENUs"
>title "File/Load"
What else than loading a file!
Try not to use filenames that dont exist!
<B>NEW FEATURE!<UB>
If you select a .guide file then Assist will convert it to an Assist
document (it will store it to a temporary directory) and then read it.
This feature will work if Assist will be able to find Convert in AUX_PRG:
assign and if the .guide file is a real .guide file.
The temporary file is TEMP:(default) but you can easily change it
by editing the Assist.init file (Check <L"startup","StartUP"> for more).
>EndNode
>Node "Keyboard"
>Title "Keyboard shortcuts"
>Toc "Intro"
* Cursur Up or key '8' from numeric keyboard :Scroll UP
* Cursor Down or key '2' from numeric keyboard :Scroll DOWN
* Cursor Left or key '4' from numeric keyboard :Jump to previous node
* Cursor Right or key '6' from numeric keyboard:Jump to next node
* Key '7' from numeric keyboard [HOME] :Move to top
* Key '1' from numeric keyboard [END] :Move to end
* key '9' from numeric keybaord [PgUp] :Scroll UP 3 lines
* Key '3' from numeric keyboard [PgDn] :Scroll DOWN 3 lines
ESC :Quit
Help :Help
The keystrokes with the '*' sign indicate that are only available if
Assist is not iconified.
>EndNode
>Node "Guide"
>Title "Some useful guidelines"
>TOC "Intro"
>Font "Courier.Font(13)"
I have some advices for you here.
<b><i>Basic <ua>
DON't use too long titles!!!
<b><i>Node names<ui><ub>
You better pick a name for a node that makes sense. For example you could
choose the name introduction for a node that describes your program
instead of NodeA for example.
<b><i>Styles<ui><ub>
You better use bold when you want to make something too noticable. Italics
are good in giving emphasis to text while underline(which i rarely use)
is good to point a certain phrase.
<b><i>Fonts<ui><ub>
You can use any font you wish. The problem is that the user may not have
that font. You should pick fonts that you are sure that someone else has
like the Topaz font or you can include the fonts in your archive.
<b><i>Multimedia<ui><ub>
Having some pictures or even animations acompanying your document is great.
The problem is that if you use animations you should state that it is an
animation since the user might have an external pic-only viewer. You
could for example have your logo spinning or something assigned to a
phrase or snapshots of your program. It is great! Also you could have
some sampled voices or even some cool sound FXs from you game(if the program
is a game). You might want to include some AREXX examples and the user
could be able to view/execute them just by clicking on a phrase, or even
assigna program that demonstrates your program to a phrase!!! There is
no limit besides your imagination!
<b><i>Misc<ui><ub>
Try not to make the document that fancy. A great document is one that
achieves its goal:to give away information. Using complex font styles
and cool logos(Bart Simpson!!) might be neat but the 'serious' users might
dislike that.
<DL>
^^ Beware of the snakes!!
00 ~~~~~~~~~~~~~~~
~\/\/\/\/\/
>endnode
>Node "Development"
>TOC "CS"
>Title "Projects under development"
>Font "Courier.font(15)"
The programs that i am currently working on
<b><i>Assist V1.8<ua>
The forecoming version. The problem is that i don't know what else to add!
